home *** CD-ROM | disk | FTP | other *** search
/ Night Owl 6 / Night Owl's Shareware - PDSI-006 - Night Owl Corp (1990).iso / 015a / rir132.zip / RIR.DOC < prev    next >
Text File  |  1991-06-13  |  22KB  |  506 lines
  1. RIR - Rock dIRectory
  2.  
  3.  
  4. Purpose
  5.  
  6.     Rock Directory (RIR) is a substitute command for DOS's
  7.     directory (DIR) with a multitude of additions.  The syntax
  8.     and output of RIR is virtually identical to that of DOS's
  9.     "DIR" command, making it easy to learn; but for the power
  10.     user, the output can be tailored in many ways to make it just
  11.     the way you like it.  RIR's important documentation is built
  12.     in (type RIR ?), but this text expands on that information.
  13.  
  14.  
  15. Uses
  16.  
  17.     RIR accepts the /W and /P parameters just as DOS's DIR
  18.     command does, as well as DOS 5.0's latest additions to DIR.
  19.  
  20.     RIR is of great use to those who have a large number of
  21.     compressed files.  Its automatic detection of compressed
  22.     files makes it easier to use than most methods of viewing the
  23.     contents of compressed files; it displays them along with a
  24.     directory's other files.  It also shows additional
  25.     information on other file types, such as the dimensions of
  26.     GIF image files.
  27.  
  28.     One of RIR's biggest advantages is the ability to tailor the
  29.     appearance of the directory listing (for example, making file
  30.     names appear in lower case letters), and saving your
  31.     "default" options in an environment variable, which can
  32.     automatically be set from an autoexec.bat file.
  33.  
  34.     RIR also lets you give more precise "file specifications,"
  35.     for example RIR can show all files *not* ending in ".bak", or
  36.     all files starting with an A *or* B.
  37.  
  38.     If your DOS version is earlier than 5.0, then you'll also
  39.     appreciate the DOS 5.0 DIR options included in RIR. DOS 5.0
  40.     includes the following options (in addition to the old /P and
  41.     /W): /? for help, /A to show hidden and other files, /O to
  42.     sort the order of the file list, /S to show files in the
  43.     specified directory and its subdirectories, and /B to list
  44.     files without any file information.  All of these options,
  45.     along with the environment variable setting, are included in
  46.     RIR.  As magazines begin to publish tips for DOS 5's DIR,
  47.     you'll be able to use the same tips with RIR.  (I'm not sure
  48.     the /O syntax is exactly the same yet, but it's quite close).
  49.  
  50.  
  51. Features
  52.  
  53.     Some of the features RIR provides that DIR does not are:
  54.  
  55.         A single key can be used to pause/restart the display,
  56.         and ESC can be used to halt the display, as with many of
  57.         the other Rock utilities.
  58.  
  59.         RIR displays the contents of compressed files, such as
  60.         ".ARC" and ".ZIP" files.
  61.  
  62.         RIR can display directory listings with two to six files
  63.         per line if desired (/2 to /6 options).
  64.  
  65.         RIR allows you to display files in lower case (/AL
  66.         option), display hidden files (/H option), show times in
  67.         24-hour format (/24 option), display file attributes (/FA
  68.         option) and more, if you prefer those settings.
  69.  
  70.         RIR will display file descriptions created with Norton's
  71.         FI or 4-DOS's DESCRIBE programs.
  72.  
  73.         RIR will also list the size & palette range of ".GIF" and
  74.         ".PCX" image files.  It can optionally list the memory
  75.         required to run .EXE files (/EC option).
  76.  
  77.         RIR can display the names of erased files (works on most
  78.         non-networked disks; note that RIR cannot unerase the
  79.         files - such resurrection requires a separate program).
  80.  
  81.         RIR accepts multiple "filespecs"; for example, you can
  82.         list all files matching *.COM and *.EXE in one command.
  83.  
  84.         Files and directories can be displayed in different
  85.         colors, according to your color and file specifications.
  86.  
  87.         RIR can translate its output (although not built-in help
  88.         or all error messages) to French, for folks who speak it,
  89.         folks learning it, or folks wanting a change of pace!
  90.  
  91.     Some of the features from MS-DOS 5.0 that RIR duplicates:
  92.  
  93.         Default parameters can be set through the RIRCMD
  94.         environment variable (see below for an explanation).
  95.  
  96.         Directories can be "recursed", so that a single RIR
  97.         command can show the contents of a directory along with
  98.         the contents of all its subdirectories - you can list
  99.         every file on a disk with one command (use /S option).
  100.  
  101.         Files can be listed one per line, without additional file
  102.         information, with the /B parameter.  The full pathname of
  103.         the file is included.  This is handy for finding files
  104.         anywhere on a disk with the /S parameter or for "piping"
  105.         filenames to the input of other programs.
  106.  
  107.  
  108. Compressed Files
  109.  
  110.     The compressed file formats that RIR can decipher are:
  111.  
  112.         .ARC, .DWC, .LBR, .LZH, .LZS, .MD, .PKA, .PAK, .ZIP, .ZOO
  113.  
  114.     Note that RIR does not decode self-extracting compressed
  115.     files, which end in .COM or .EXE.
  116.  
  117.  
  118. What are compressed files?
  119.  
  120.     Not everyone uses, or needs to use, compressed files.  This
  121.     section is for those who are confused by what the term
  122.     "compressed file" means.
  123.  
  124.     A compressed file is a single file created to store one or
  125.     more other files in a "compressed" format to save space.  A
  126.     special compression/decompression program is required to do
  127.     this, such as "ARC" or "PKZIP," both available from most
  128.     shareware distribution sources or bulletin board systems.
  129.  
  130.     Compression is used for several reasons; to save space with
  131.     old files that are rarely used, to fit a lot of data on
  132.     floppy disks, or to send file through telephone lines more
  133.     quickly.  You might squeeze five 100K text files into a
  134.     single 200K compressed file, store it on a floppy, and when
  135.     you need it again, decompress it into the original five
  136.     files.  Those who download files with modems usually receive
  137.     the files in a compressed form - it's faster to download
  138.     smaller files, and with some systems, time is money!
  139.  
  140.     It's often convenient to view the contents of compressed
  141.     files without actually decompressing them.  Most
  142.     decompression programs can show the contents of files
  143.     compressed in their own format, but each compression program
  144.     has its own file format.  RIR shows you the contents of many
  145.     formats of compressed files.
  146.  
  147.  
  148. Syntax
  149.  
  150.     This section is rather long, and is not required reading; if
  151.     you're a new user, just skim the examples so you know RIR's
  152.     capabilities, and when you want to do those things, use this
  153.     section as a reference (or type RIR ? the same info).
  154.  
  155.     RIR [d:][path][filespec] [options] [AND/BUT NOT filespec]
  156.  
  157.     Options
  158.        /P      Pause after each screen page of display
  159.        /W      List files with up to five filenames on each line
  160.        /1 - /6 List 1 to 6 filenames on each line (default /1)
  161.        /S      List files in the specified dir and all subdirs
  162.        /FR     Traduis à le français - Translate output to French
  163.        /?      Show RIR's built-in help information
  164.        /INFO   Show information about the Rock utilities
  165.        /ORDER  Output a Rock Utilities order form
  166.  
  167.     Examples
  168.        rir             Show current dir, with compressed files
  169.        rir /p          Show current dir, pausing every screen
  170.        rir /w          Show current directory, 5 files per line
  171.        rir c:\new\*.*  Show files in the directory c:\new
  172.        rir a: /2       Show directory of A:, 2 files per line
  173.        rir ? > PRN       Send the help screens to the printer
  174.        rir ? > file.txt  Send the help screens to file "file.txt"
  175.        rir /order > PRN  Print the Rock Utilities order form
  176.  
  177.     Control Keys
  178.        ESC     Stop the program immediately
  179.        Others  Pause the program until next key pressed
  180.  
  181.     Control Options
  182.        /A:att   Show only files with the attributes specified
  183.                 att can be R H S and/or A: ReadOnly, Hidden,
  184.                 System, or Archive (e.g., /A:H shows just hidden)
  185.        /O:ord   Displays files sorted in the specified order
  186.                 ord can be N E S D and/or T: Name, Extension,
  187.                 Size, Date, or Time (e.g., /O:N sorts by name)
  188.                 append dash to to the letter to reverse the sort
  189.                 (e.g. /O:D-T- sorts reverse chronologically)
  190.        /E       Include Erased files/dirs (not w/all disks/DOS's)
  191.        /FA      Show file attributes of all files/directories
  192.                 [RHSDA]=ReadOnly/Hidden/System/Directory/Archive
  193.        /H       Include Hidden files/directories in list
  194.        /1STnn   Show only 1st nn files/dirs (/1ST20 shows 1st 20)
  195.        /ND /JD  No Directories or Just Dirs shown
  196.        /NK      No one-key pause/abort
  197.        /1K      Enable one-key pause/abort even when redirected
  198.        /I       Ignore RIRCMD environment variable (see below)
  199.  
  200.     Output Options
  201.        /LJF    Left-Justify Files ("fname.ext" not "fname   ext")
  202.        /24 /12 Show times in 24- or 12-hour mode; USA default /12
  203.        /M /D /Y Show dates starting with month, day, or year
  204.        /AU /AL All Upper or All Lower case files and directories
  205.        /ALF    All Lower case names for Files (not directories)
  206.        /SVS    Show Volume serial number (for DOS 4.0+ disks)
  207.        /T      Text lines only, e.g. <-- instead of <──
  208.        /JFS    Just Free Space (only give bytes free at end)
  209.        /EC     EXE comments; show required memory for EXE files
  210.        /NEC    No Expansion of Compressed files
  211.        /NC     No Comments (right half of 1-column listing)
  212.        /NFS    No File Stats at all (no time/date, size)
  213.        /NCF    No Compressed File comments (# & size of contents)
  214.        /N4D    No 4-Dos comments (ignore 4-DOS file descriptions)
  215.        /NFI    No FI comments (skip Norton FI file descriptions)
  216.        /NV /NT No Volume label or No program Title shown at top
  217.        /NH     No header at top at all (no "RIR", volume, etc.)
  218.        /NF     No footer at bottom at all (no files, free space)
  219.        /B      Show just filenames with full paths, no other info
  220.        /BIOS    Use slower BIOS output instead of direct writes
  221.  
  222.      Yet More Examples!
  223.        rir not *.bak         Show all except .BAK files
  224.        rir *.com and *.exe   Show all .COM and .EXE files
  225.        rir *.exe but not r*  Show .EXE files not starting with R
  226.  
  227.        rir \*.bak /b /s      Find all *.BAK files on current disk
  228.        rir \ /a:a /b /s >bu  Log all files needing backup to "bu"
  229.        rir /o:d-t- /1st20    Show the most recent twenty files
  230.  
  231.        rir /fr /d /24        French output w/European date & time
  232.        rir /nfs /nh /nf /nd  Just files; no dirs or anything else
  233.        rir /e /h             Show all files, even hidden & erased
  234.  
  235.        rir /ljf /alf /nh     Left-justified, lowercase, no header
  236.  
  237.  
  238. Colorized Directory Listings
  239.  
  240.     RIR has the ability to list files in different colors, for
  241.     example showing all *.EXE in red.  To do this, a special
  242.     color definition file (example given below) tells what colors
  243.     to use, and the /C parameter (described below) tells RIR that
  244.     you want to use that special color file.
  245.  
  246.     Color Options
  247.        /C"file"  Color directory entries according to directions
  248.                  in "file"
  249.        /CN       Color name only, not file size, time, etc. (use
  250.                  with above /C)
  251.  
  252.     Examples
  253.        rir /C"c:\colors.rir"  Show directory using defs in
  254.                               c:\colors.rir
  255.        rir /C"d:\my.cls" /CN  Same, but only colorizing file name
  256.  
  257.     A sample color definition file is included with RIR (called
  258.     COLORS.RIR), and a smaller version is shown below:
  259.  
  260.        default file lgray
  261.        default dir  lblue
  262.        *.COM lred
  263.        *.EXE lred
  264.        *.BAK gray
  265.        *.DOC white
  266.        *.ARC lmagenta
  267.        *.ZIP lmagenta
  268.  
  269.     You can edit or create your own color definition file with
  270.     any text editor.  The lines beginning with "default file" and
  271.     "default dir" color tell RIR what colors to use if a file or
  272.     directory don't fall under any of the other file
  273.     specifications in the file (e.g., a file named "uh.oh" would
  274.     be colored light gray, because it does not fall under the
  275.     category *.com, *.pas, etc.)
  276.  
  277.     The other lines tell what colors to use for other files, for
  278.     example all *.COM files will be shown in "lred", or light
  279.     red.  Possible color names include:
  280.  
  281.       Black  Red    Magenta   Blue   Green   Cyan   Brown   LGray
  282.       Gray   LRed   LMagenta  LBlue  LGreen  LCyan  Yellow  White
  283.  
  284.     Blank lines or lines beginning with a semicolon are ignored
  285.     in the color definition file.
  286.  
  287.     If you use RIR's color feature, the "environment variables"
  288.     section below will be very useful to you.  By adding a
  289.     command such as SET RIRCMD /C"C:\COLORS.RIR" into your
  290.     autoexec.bat file, RIR will use display listings in color
  291.     automatically, without your having to type in the color file
  292.     name each time you run it.
  293.  
  294.  
  295. Environment Variables
  296.  
  297.     If you use certain options a lot, save typing with the RIRCMD
  298.     environment variable to set RIR's default parameters, for
  299.     example type "SET RIRCMD /P".
  300.  
  301.     An environment variable is a piece of information you record
  302.     from the DOS command line to be used by various programs.
  303.     Each environment variable consists of a one-word name and an
  304.     associated value for the variable, generally a set of words
  305.     or symbols.  If you type "SET" from the DOS command line,
  306.     you'll see your current environment variables.  Common ones
  307.     include "prompt" and "path", usually set in an autoexec.bat
  308.     file.  Most DOS handbooks contain a more in-depth discussion
  309.     of environment variables and their typical uses.
  310.  
  311.     To set an environment variable, you type something like "SET
  312.     NAME=WHATEVER VALUE", creating a variable called "NAME" with
  313.     the associated value "WHATEVER VALUE", which resides in DOS
  314.     memory until you turn your machine off.  If you type "SET"
  315.     now, DOS will list "NAME" along with any previously set
  316.     environment variables.
  317.  
  318.     How does RIR use environment variables? If you use certain
  319.     options almost always, you can save typing by setting a
  320.     variable called "RIRCMD" with the options you typically use
  321.     with RIR.  Every time you run RIR, it will first check the
  322.     RIRCMD variable to see if you set any options that you want
  323.     used every time you run RIR.
  324.  
  325.     For example, type "SET RIRCMD /P /24" from the DOS command
  326.     line to have RIR use the /P and /24 options until you turn
  327.     the system off, or add it to your autoexec.bat to set the
  328.     parameters each time you boot your system, so RIR will always
  329.     use the /P and /24 options.
  330.  
  331.  
  332. Customizing output
  333.  
  334.     If you have several sets of default options that you like to
  335.     use with RIR, here are two suggestions.  One is to have
  336.     separate batch files that run RIR with a particular set of
  337.     command-line options, for example "WDIR.BAT" might contain
  338.     the line "RIR %1 /W /P /AL".  Another approach is to have
  339.     batch files that set the RIRCMD environment variable, for
  340.     example "WDIR.BAT" could similarly contain the line "SET
  341.     RIRCMD /W /P /AL", so that after you run wdir once, you can
  342.     just run RIR, and it will use those parameters.
  343.  
  344.  
  345. File Attributes
  346.  
  347.     If you use the /FA parameter, each file will be followed by a
  348.     pair of bracket with attribute codes between them, such as
  349.     "[RHSDA]".  Only some of the letters will appear between
  350.     brackets for any particular file or directory.  The letters
  351.     stand for the following:
  352.  
  353.            R - Read only   H - Hidden      S - System
  354.            D - Directory   A - Archive
  355.  
  356.  
  357. Trouble-shooting
  358.  
  359.     If you have problems displaying RIR's output, or get CGA
  360.     "snow", try using the /BIOS parameter.  Some programs (like
  361.     FANSI, PC-Kwik, other TSRs, and many speech synthesizers)
  362.     require BIOS output to work properly.
  363.  
  364.  
  365. Miscellaneous Tips
  366.  
  367.     Tip for RAM disk users: To make RIR (or any program or batch
  368.     file) run faster, copy it to your RAM disk, then put the RAM
  369.     disk's path first in your PATH environment variable.  For
  370.     example, if your RAM disk is D:, add to your autoexec.bat:
  371.  
  372.            COPY C:\ROCK\RIR.EXE D:\
  373.            PATH D:\;C:\ROCK;C:\DOS;....
  374.  
  375.     Tip for DOS 4.0+ users: To speed everything up, use DOS's
  376.     FASTOPEN program (it should be in your DOS directory).  For
  377.     example type FASTOPEN C:=100 to speed up your C: drive.  DOS
  378.     will then remember where the last 100 files it opened are
  379.     located, letting it open them faster.  Don't use FASTOPEN
  380.     with other disk caches & optimizers!
  381.  
  382.     Tip for 4DOS users: You can type DIR to run RIR!  Type "ALIAS
  383.     DIR D:\RIR" (assuming RIR is in the root directory of D:), or
  384.     add the alias to your aliases file if you have one.  If you
  385.     want to use 4DOS's built-in DIR after that, type *DIR instead
  386.     of DIR.
  387.  
  388.  
  389. Ordering Information
  390.  
  391.     Type "RIR /INFO" for information on the Rock Utils, or "RIR
  392.     /ORDER" for an order form.  You can print the order form by
  393.     typing "RIR /ORDER >PRN", or route it to a file with "RIR
  394.     /ORDER >FILE.TXT", and then edit the file before printing. In
  395.     summary, for $22, you get a registered copy of the Rock
  396.     Utilities, a set of 30 programs which includes RIR.  That
  397.     gets you a nice printed manual along with the latest copy of
  398.     the Rock Utilities.  Remember to specify disk size!  Mail a
  399.     check to Rock Systems at 101 N Main Street, Suite 150-125,
  400.     Ann Arbor, MI  48104.  Your support is very appreciated!
  401.  
  402.  
  403. Credits
  404.  
  405.     RIR's compressed file directory routines came from several
  406.     sources, including Phil Burn's PIBCAT, a public domain disk
  407.     cataloging system, and Don Williams' Fast File Find program.
  408.     And thanks to everyone who's provided so many suggestions!!
  409.  
  410.  
  411. Example - show current directory
  412.  
  413.     The arrows following the extensions in the following examples
  414.     indicate that the file is contained within the compressed
  415.     file preceding it.  In the example below, the file
  416.     "TTOOLS.ZIP" contains the files "TTOOLS.TPU", "TTOOLS.PAS",
  417.     and "READ.ME".  Note that the default directory listing is
  418.     easier to read than the listings with two or five-files per
  419.     line.  Two user-created file descriptions are listed in the
  420.     first example; creating them requires other programs.  The
  421.     other three comments, to the right of the files, were created
  422.     by RIR based on information in the file, for example the
  423.     dimensions of the "GIF" image file.  The last file listed is
  424.     an erased file, which is shown because of the /e option.
  425.  
  426.     C:\DATA>rir /svs /e
  427.     RIR-Rock dIRectory 1.31, (C) 1991 Rock    "RIR ?" for options
  428.  
  429.      Volume in drive C is Devel
  430.      Volume Serial Number is 1515-15E1
  431.      Directory of  C:*.*
  432.  
  433.     .           <DIR>     01-07-91  1:36a
  434.     ..          <DIR>     01-07-91  1:36a
  435.     BART     GIF   191529 12-15-90 10:33a 800x600 256 colors
  436.     BINOBJ   EXE    11088 08-29-88  5:00a This comment made w/FI
  437.     PRINT    TP5     2917 07-21-89 11:27a This one made w/4-DOS
  438.     FILEINFO FI       522 12-28-90  1:47a Contains 1 file comment
  439.     TPC      EXE    61926 05-02-89  5:50a
  440.     TPUMOVER EXE    32784 08-29-88  5:00a
  441.     TURBO    EXE   156321 05-02-89  5:50a
  442.     TURBO    TPL    44352 05-02-89  5:50a
  443.     TTOOLS   ZIP<╕  26752 11-01-90  8:45p 3 files in 42974 bytes
  444.     ttools   tpu─┤  34426 12-31-86  6:46p
  445.     ttools   pas─┤   7309 12-31-86  6:42p
  446.     read     me ─┘   1239 12-30-86  9:31p
  447.     ?RINT    TP4     3104 07-21-89  5:50a Erased
  448.           12 File(s)     531295 bytes
  449.                         6100992 bytes free
  450.  
  451.  
  452. Example - show in wide mode, no header (normally 5 files/line)
  453.  
  454.     C:\DATA>rir /w /nh /jfs
  455.     .              ..             BART    GIF    TEMP     BAK
  456.     BINOBJ   EXE   FILEINFO FI    PRINT   TP5    TPC      EXE
  457.     TPUMOVER EXE   TURBO    EXE   TURBO   TPL    TTOOLS   ZIP═══
  458.     ttools   tpu──ttools   pas──read    me
  459.           11 File(s)    6100992 bytes free
  460.  
  461.  
  462. Example - single column, left-justified filenames, all lowercase,
  463.     24-hour mode, no comments, no header, no footer, no expansion
  464.     of compressed files, and no directories listed.  (First sets
  465.     the rircmd variable so won't have to retype it next time!)
  466.  
  467.     C:\DATA>set rircmd /ljf /al /24 /nc /nh /nf /nec /nd
  468.     C:\DATA>rir
  469.     bart.gif       191529 12-15-90 10:33
  470.     binobj.exe      11088 08-29-88  5:00
  471.     print.tpf        2917 07-21-89 11:27
  472.     fileinfo.fi       522 12-28-90  1:47
  473.     tpc.exe         61926 05-02-89  5:50
  474.     tpumover.exe    32784 08-29-88  5:00
  475.     turbo.exe      156321 05-02-89  5:50
  476.     turbo.tpl       44352 05-02-89  5:50
  477.     ttools.zip      26752 11-01-90 20:45
  478.  
  479.  
  480. Example - list the five most recent files.  This example assumes
  481.     "rircmd" was as in the last example, and just adds two more
  482.     options to sort and to list the first five files.
  483.  
  484.     C:\DATA>rir /o:d-t- /1st5
  485.     fileinfo.fi       522 12-28-90  1:47
  486.     bart.gif       191529 12-15-90 10:33
  487.     ttools.zip      26752 11-01-90 20:45
  488.     print.tpf        2917 07-21-89 11:27
  489.     tpc.exe         61926 05-02-89  5:50
  490.  
  491.  
  492. Example - Same, but include hidden files and show the attributes.
  493.     The second file is hidden, indicated by the H at the right,
  494.     the first three have the archive bit set (meaning they
  495.     haven't been saved by a backup program since last modified),
  496.     and the last file is read-only, so it can't be erased
  497.     accidentally.  See documentation for RFA (Rock File
  498.     Attributes) for a more complete discussion of the topic.
  499.  
  500.     C:\DATA>rir /o:d-t- /1st5 /h /fa
  501.     fileinfo.fi       522 12-28-90  1:47 [    A]
  502.     secret.cod         12 12-18-90 14:23 [ H  A]
  503.     bart.gif       191529 12-15-90 10:33 [    A]
  504.     ttools.zip      26752 11-01-90 20:45 [     ]
  505.     print.tpf        2917 07-21-89 11:27 [R    ]
  506.